The Picture object

The Picture object is used to represent a picture in an album.

Properties:

Methods:

HasKeyword(pszKW As String) As Boolean
Test if the picture has the given keyword.

SetKeyword(pszKW As String, bSet As Boolean) As Boolean
Set or clear the specified keyword for the picture.

GetCustomField(pszCF As String) As String
Get the value of the specified custom field. This method can be used whatever the type of the custom field.

GetCustomFieldDate(pszCF As String) As Long
Get the time value (time_t) of the specified custom field. This method can only be used with date or time custom fields.

SetCustomField(pszCF As String, pszValue As String)
Set the string value of the specified custom field. This method can only used with string custom fields.

SetCustomFieldDate(pszCF As String, lDateTime As Long)
Set the time value of the specified custom field. This method can only be used with date or time custom fields.

SaveThumbnail(sNewFile As String, nFileType As Long) As Boolean Save the thumbnail of the picture in a file.

ConvertAndResize(sNewFile As String, nFileType As Long, nNewWidth As Long, nNewHeight As Long) As Boolean
Convert and/or resize the picture and save it to a new file. Set nNewWidth and nNewHeight to zero to keep the same dimensions.

ConvertAndResize2(sNewFile As String, nFileType As Long, nNewWidth As Long, nNewHeight As Long, nResizeMode as Long, crBack as Long, nAngle as Long) As Boolean
Extended version of ConvertAndResize. If nResizeMode = RM_BOUNDINGRECT (0), the specified size is the maximal size of the picture (preserving the aspect ratio), if nResizeMode = RM_EXACTSIZE (1) a border filled with the crBack color is added to match the specified size, if nResizeMode = RM_STRETCH (2) the picture is freely resized to the specified size (aspect ration non preserved). Rotation (angle must be 0, 90, 180 or 270) and cropping are available.

Resize(nNewWidth As Long, nNewHeight As Long, nResizeMode as Long, crBack as Long, nAngle as Long) As Boolean
Same as ConvertAndResize2 but the modified picture is not saved to a file and reside only in memory.

SetCropRect (l As Long, t As Long, r As Long, b as Long)
Set the cropping rectangle (left, top, right, bottom) used by ConvertAndResize2 and the display cropping. Set all coordinates to zero to cancel cropping. Cropping rectangle can also be accessed with the rcCrop property.

UpdateThumbnail(bForce As Boolean) As Boolean
Update the thumbnail if the picture has changed or update it anyway if bForce is True.

Copy(nPic As Long) As Boolean
Copy the picture to the clipboard (nPic=-1, copy the thumbnail, nPic=0..n, copy the picture or one of the sub-pictures).

CopyRect(left As Long, top As Long, right As Long, bottom As Long, nPic As Long) As Boolean
Copy a rectangle from the picture to the clipboard. Coordinates are from the upper left corner of the picture. The nPic parameter is unused and must be zero.

PasteToThumbnail(bResize As Boolean) As Boolean
Replace the thumbnail with the bitmap content of the clipboard. If bResize is True, the bitmap is resized to match the album thumbnail size.

SetTextStampInfo(sText As String, sFont As String, crColor As Long, xPos As Long, yPos As Long) As Boolean Set the stamping information (text) for the ConvertAndResize method.

SetPictureStampInfo(sPicFile As String, xPos As Long, yPos As Long) As Boolean
Set the stamping information (bitmap) for the ConvertAndResize method.

Paste(xPos As Long, yPos As Long) As Boolean
Paste the bitmap from the clipboard to the picture at the specified position.

DrawText(sString As String, rect As Object, sFont As String, crColor As Long, crBkColor As Long, nFormat As Long) As Long
Draw a text on the picture. rect is the bounding text and must be a MyAlbum.rect object. Set crBkColor to -1 for a transparent background. For the nFormat use the DT_xxx constants of the DrawText Windows API.

DrawLine(x1 As Long, y1 As Long, x2 As Long, y2 As Long, nWidth as Long nStyle As Long, crColor As Long) As Long
Draw a line on the picture. nWidth specifies the style: 0 for solid, 1 for dashed.

DrawRectangle(rect As Object, nWidth As Long, crFrameColor As Long, crFillColor As Long, bStyle As Long, wE As Long, hE As Long) As Boolean
Draw a rectangle (nStyle=DRAWRECT_RECT (0)), a rounded rectangle (nStyle= DRAWRECT_ROUNDRECT (1)) or an ellipse (nStyle= DRAWRECT_ELLIPSE (2)) on the picture. rect specifies the size of the drawing and must be a MyAlbum.MyRect object. You can specify a border with a width (nWidth) and a color (crFrameColor or -1 for an unfilled drawing).

GetPixel(x As Integer, y As Integer) As Long
Gets the color of the pixel at coordinates x and y. 0,0 is the upper-left corner of the picture. The returned value is coded in RGB (one byte for each color). û1 is returned if an error occurs (the picture must be a 8, 16, 24 or 32 bit per pixel bitmap).

SetPixel(x As Integer, y As Integer, color As Long)
Sets the color of the pixel at coordinates x and y. 0,0 is the upper-left corner of the picture. The color parameter is coded in RGB (one byte for each color). The picture must be a 16, 24 or 32 bit per pixel bitmap.

Mirror() As Boolean
Mirror the image (left <--> right).

Flip() As Boolean
Flip the image (top <--> bottom).

GetPicDataType(iPicData As Long) As Long
Get the type of a picture data block.

GetPicDataSize(iPicData As Long) As Long
Get the size of a picture data block.

SavePicData(iPicData As Long, sFile As String) As Boolean
Save a picture block in a file.

Load(bLoad As Boolean) As Boolean
Load (or unload) the picture in memory.

Save( sNewFile as String, bReplaceInAlbum As Boolean) As Boolean
Save the loaded picture to a new file (using its current state in memory). Set the bReplaceInAlbum to True to have the new filename used in the current album instead of the current picture filename.
Caution: Specifying the name of an existing file will overwrite it.

xmlEncode(nType as long, [optional] uFlags as Long) As String
Encode the picture as a XML string. nType is reserved and must be 0.
By default external files (the picture file and the files referenced by the Play Command) are included in the xml stream.
Optional parameter: uFlags = XML_Default.

SetAsWallpaper(bUseCropRect as Boolean) As Boolean
Set the picture as the desktop wallpaper. Set bUseCropRect to True to use only the part of the picture defined by its cropping rectangle.

MakeAnaglyph(picLeft As Object, picRight As Object, nAnaType As Short, dx As Short, dy As Short) As Boolean
Compute a 3D picture from two pictures. Use the T3D_... constants (see below) for the nAnaType parameter. The dx and dy parameters are used to specify the offset of the right picture.

Constants:

Picture status:

This is a 32 bit value containing various information:

XML Export/Import options:

This is a 32 bit value containing the following information:

MakeAnaglyph constants: